home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / applications / databases / quickfile38.lha / QuickFile / QuickFile.doc < prev    next >
Encoding:
Text File  |  1995-02-06  |  37.5 KB  |  1,103 lines

  1.   Quickfile v3.8 copyright 1992-1995 by Alan Wigginton
  2.  
  3. I accept no liability for any loss or damage resulting from the use of
  4. this program.  Users must evaluate the program and decide its usefulness
  5. for their own purposes.
  6.  
  7. QuickFile is not Public Domain, however it can be freely distributed
  8. provided all documentation and sample files are included unchanged.
  9.  
  10. QuickFile is a flexible, flat file database. It uses random access with
  11. indexing for fast access to records. Files can be larger than available
  12. ram, but as much of the file as possible is kept in ram to reduce disk
  13. accesses. Features include:
  14.  
  15.     - Multiple indexes with unique and non-unique keys
  16.     - Character, date, integer, floating point and calculation data types
  17.     - Up to 250 characters per field  and 250 fields per record.
  18.     - Form and list style displays and reports.
  19.     - Unlimited number of views of each file.
  20.     - Sort over any number of keys, ascending and descending order.
  21.     - Search operators include Like, Equal, Between, Sounds Like, Not Like
  22.       and Not Equal.
  23.     - Fields can be added, changed, or deleted at any time.
  24.     - ASCII export/import
  25.     - ulti column label printing.
  26.     - Multi-level grouping and totalling
  27.     - Any number of open windows
  28.     - Online context sensitive AmigaGuide help
  29.  
  30. System Requirements
  31.  
  32.     Any Amiga computer with 512K or more RAM
  33.     Workbench 2.04 or later
  34.     mathieeesingtrans.library
  35.     mathieeedoubbas.library
  36.     mathieeedoubtrans.library
  37.  
  38. QuickFile will work with XFH-handler (a file compression program) but
  39. XFH-handler requires that the decompressed file fit completely in ram.
  40. To work with QuickFile such programs must support update of an existing
  41. file.
  42.  
  43. QuickFile is written in C using DICE version 3.0.
  44.  
  45. ====== CONDITIONS OF USE =====
  46.  
  47. This version of the program can be used for free on the condition that you
  48. write and let me know that you are using it - a postcard will do.
  49.  
  50. Donations of money, stamps, software etc will be gratefully accepted. If
  51. you would like to register for updates, bug fixes and support, please send
  52. at least $20.00 to the address below. Overseas users please use
  53. international money order or bank draft - not personal cheques. Any cash
  54. currency is OK, but you send it at your own risk.
  55.  
  56.       Alan Wigginton
  57.       23 Carissa St
  58.       Shailer Park, Queensland  4128.
  59.       AUSTRALIA
  60.  
  61. Registration will get you the latest version of the program and prompt
  62. attention by mail to any problems you may encounter. You will also be
  63. advised when major upgrades are available.
  64.  
  65.  
  66. WARNING. QuickFile is a random access data base that buffers records in
  67.      memory. Failure to exit the program properly after updates are
  68.      made will result in lost updates.
  69. ALWAYS     exit the program before a reboot or power off.
  70. DO     backup your files regularly.  When backing up a data base make
  71.      sure you backup all of the files - definition, data and indexes.
  72.  
  73. To install QuickFile to a hard disk or floppy, drag the QuickFile icon to
  74. the drawer of your choice. If you want to use the AmigaGuide help system,
  75. copy QuickFile.guide to the same directory. To install AmigaGuide
  76. doubleclick on the InstallAmigaGuide icon.
  77.  
  78. Icons are not generated by the program. Sorry, but if you want them you
  79. will have to create them yourself.
  80.  
  81. ===== Starting QuickFile ======
  82.  
  83. QuickFile may be started from Workbench using either the program icon or a
  84. project icon.
  85.  
  86. It may also be started from the CLI. The program name may be followed by
  87. a file name.
  88.  
  89. QuickFile opens a window on the default public screen. The default window
  90. size is a few pixels smaller than the screen size. Window size and
  91. position are saved when a view is saved.
  92.  
  93. ===== About Views ======
  94.  
  95. Views allow you to display data from a file in different ways. There are
  96. two basic types FORM and LIST.
  97.  
  98. Each view has its own field titles, positions and lengths, window size and
  99. report details. Once you have a view set out the way you want it, you can
  100. save it for future use.
  101.  
  102. The Define View requester is used to select or change the fields included
  103. in a view. The positions of fields on a form can be changed by dragging
  104. them around with the mouse.
  105.  
  106. When you open a file, QuickFile looks for a view called filename.VIEW. To
  107. automatically use your favourite view, save it as filename.VIEW in the
  108. same directory as the data base.
  109.  
  110. If you want to keep things simple and are happy with the default view, you
  111. need not define a view at all.
  112.  
  113. Views are typically used to print labels, export or import selected fields
  114. or print lists containing only selected fields.
  115.  
  116.  
  117. =========== Keyboard ===================
  118.  
  119. The following keys are available when the cursor is not in a string
  120. gadget (Press RETURN or ESC to de-activate a string gadget):
  121.  
  122.    RETURN    Same as OK button
  123.    ESC        Same as CANCEL button
  124.    TAB        Activate first string gadget
  125.    HELP     Displays help. Requires Amigaguide.library in libs: and
  126.         QuickFile.guide in the same drawer as QuickFile.
  127.  
  128. The following keys can be used in string gadgets:
  129.  
  130.    TAB              Move to next field
  131.    Shift-TAB          Move to previous field
  132.    Down arrow          Move to next field
  133.    Up arrow          Move to previous field
  134.    Return          De-activate string gadget if value is valid
  135.    ESC              De-activate string gadget ignoring errors
  136.    right Amiga-X      Erase all text in the gadget (as does Control-X)
  137.    right Amiga-Q      Restores the text that was present before you
  138.               changed it.
  139.    Shift-left arrow   Moves the cursor to the beginning of the field.
  140.    Shift-right arrow  Moves the cursor to the end of the field.
  141.    Shift-Del          Erases all characters from the cursor to the end of
  142.               the gadget.
  143.    Shift-Backspace    Erases all characters to the left of the cursor.
  144.  
  145. ============== MAIN WINDOW =================
  146.  
  147. Windows can be resized using the sizing gadget. The zoom gadget will
  148. iconify the window (reduce to a short title bar).
  149.  
  150. ===== Form Display ======
  151.  
  152. The FORM DISPLAY shows a single record per screen in the format specified
  153. by the current view.
  154.  
  155. Field positions can be changed by dragging fields around the window with
  156. the mouse. Field sizes can be changed by dragging the bottom right corner
  157. of the drag box. Note that although field height can be changed, fields
  158. are still limited to a single line.
  159.  
  160. To add or delete fields, change field titles or displayed lengths, press
  161. the VIEW button;
  162.  
  163. ===== List Display ======
  164.  
  165. The LIST display shows as many records as will fit in the window with a
  166. single line per record.
  167.  
  168. To update a record double click on it with the left mouse button
  169.  
  170. Before using the Modify or Delete buttons, select a record using a single
  171. press of the left mouse button.
  172.  
  173. ===== Buttons =====
  174.  
  175. GoTo
  176.   GoTo finds a record by key value using the current index. This makes
  177.   access extremely fast, even on large files.
  178.  
  179.   You only need to enter enough of the key to identify the record you
  180.   want, but you must start at the first key field.
  181.  
  182. Modify
  183.   Allows you to modify the current record. The horizontal scroll gadget
  184.   can be used to scroll the display and access fields that do not fit in
  185.   the window.
  186.  
  187. Insert
  188.   Displays a blank form for you to enter values for a new record.
  189.  
  190.   The Copy button will copy the contents of the previous record. This is
  191.   useful if you are entering records with similar values in some fields of
  192.   each record. Warning - it replaces anything currently on screen.
  193.  
  194.   Press Cancel (or ESC) to return to Browse mode.  NB When Cancel is
  195.   pressed any values displayed on the screen will be lost.  Press OK
  196.   to insert the record, then Cancel.
  197.  
  198. Delete
  199.  
  200.   Deletes the current record. A requester is displayed to confirm.
  201.   Once the record has been deleted you cannot get it back.
  202.  
  203. Form/List
  204.   Toggles the current view between FORM and LIST formats.
  205.  
  206. View
  207.   Pressing the VIEW button displays the Define View requester with the
  208.   current view.
  209.  
  210. ===== Scrolling =====
  211.  
  212.   Scrolling is controlled by two slider type gadgets.
  213.  
  214.   Vertical Slider
  215.     This controls movement through the file and works in the usual way.
  216.     Scrolling may also be done using the up and down arrow keys for a
  217.     single record, or the shifted keys for a full screen.
  218.  
  219.   Horizontal Slider
  220.    If there are more fields than will fit in the current window, this
  221.    can be used to display the next group of fields.
  222.  
  223. ===========PROJECT  MENU ===================
  224.  
  225. OPEN
  226. Opens a new file in a new window.
  227.  
  228. LOAD
  229. Opens a new file, replacing the file in the current window.
  230.  
  231. SAVE
  232. Writes all updated blocks and indexes to disk.
  233.  
  234. CLOSE
  235. Writes all updated records and indexes to disk and closes the file and
  236. window.  Closing the last window will exit the program.
  237.  
  238. SAVE AS
  239. Creates a new file from the current file. Indexes for the new file are not
  240. created - they will be built when you first open the new file.
  241.  
  242. NEW
  243. Opens a new window for you to define a new file.
  244.  
  245. ALTER
  246. Displays the file definition panel for you to alter the current file
  247. definition. Note that the data and any updated views are saved first.
  248.  
  249. EXPORT
  250. Writes all, or selected, records to an ASCII file for exchanging data with
  251. other applications such as word processors, other data bases etc. The
  252. order and length of the fields in the export file is determined by the
  253. current view. Before doing the export, you may need to create a new view
  254. to give the record layout you want. See export section for details.
  255.  
  256. IMPORT
  257. Loads records from an ASCII file into your data base. The sequence and
  258. length of fields in the input file are determined from the current view.
  259. You should create and select the view before selecting the import
  260. function. See Import section for details.
  261.  
  262. REORGANISE
  263. Reorganises a file by creating a new optimised version and then copying
  264. that version over the main file.
  265.  
  266. Reorganising is not essential, but if you have been doing many additions
  267. and deletions, it may reduce file size and will improve performance.
  268.  
  269. During reorganisation free space is adjusted to the value specified in
  270. the file definition and records are physically stored in the sequence of
  271. the active key. Select your most used key sequence before reorganising to
  272. optimise access with that key.
  273.  
  274. ========= VIEW MENU ==========
  275.  
  276. VIEWS
  277. Displays a requester showing a list of currently loaded views for you to
  278. choose from. If you have not created or loaded any views, you will have a
  279. single view called filename.VIEW.
  280.  
  281. Press the Close button to drop the selected view. You cannot close all
  282. views - you must have at least one loaded.
  283.  
  284. NEW
  285. Creates a new view called 'unnamed' and displays it in the define View
  286. requester.
  287.  
  288. LOAD
  289. Loads another view from disk which becomes the current view.
  290.  
  291. If fields in the view cannot be located in the file definition, they will
  292. be dropped, and a requester displayed to warn you. This will happen if you
  293. delete fields from the file or change field names in the file definition.
  294.  
  295. SAVE
  296. Saves changes made to an existing view. If the view has been newly created
  297. a file requester will be displayed to confirm the name.
  298.  
  299. SAVE AS
  300. Saves the current view under a new name. A view can have any name but the
  301. .view suffix should be used for easy identification.
  302.  
  303. RESET FORM
  304. Resets field positioning back to the default.
  305.  
  306. ========== ORDER MENU =========
  307.  
  308. INDEXES
  309. Displays a list of indexes. Choose an index fromt the list to change the
  310. display sequence. If you have performed a sort or selection, the list will
  311. include "Selected" and/or "Sorted".
  312.  
  313. Pressing the Close Button will remove a "Sort" or "Selection" from memory
  314. and free the space used. To remove any permanent index use the
  315. Project/Alter menu item to alter the file definition.
  316.  
  317. SORT
  318. Displays the sort requester to sort into a new sequence
  319.  
  320. SHOW SORTED
  321. Uses last sort for the display sequence.
  322.  
  323. REBUILD INDEX
  324. Rebuilds the current index from the data file.
  325.  
  326. This can be used if the index and data files are inconsistent for some
  327. reason (eg a system failure). The index is rebuilt from the data file.
  328.  
  329. Try using this if the program is failing with a 'Block not found message'
  330. or any messages to the effect that QuickFile could not find a record it
  331. looked for.
  332.  
  333. ======= SELECTION MENU ===========
  334.  
  335. SELECT
  336. Searches for records matching your selection criteria. See later for full
  337. details.
  338.  
  339. SHOW SELECTED
  340. Displays current selection
  341.  
  342. SHOW ALL
  343. Displays all records. The current selection is retained.
  344.  
  345. ======= PRINT MENU ===============
  346.  
  347. DISPLAYED RECORDS
  348. Prints the records currently displayed on the screen. This will be a
  349. single record for a form display.
  350.  
  351. ALL RECORDS IN CURRENT INDEX
  352. Prints all records in the current index (or Sort or Selection).
  353.  
  354. The fields printed and the style (form or list) of report is determined by
  355. the current view.
  356.  
  357. See Print Requester for full details
  358.  
  359. =============== OPTIONS MENU ====================
  360.  
  361. ABOUT
  362. Too obvious to explain
  363.  
  364. BUFFERS
  365. Displays number  of blocks in the file and the maximum and in-use number
  366. of RAM buffers. You can change the maximum number of ram buffers. To
  367. permanently change the maximum number of buffers, use the Project/Alter
  368. menu item to change the file definition.
  369.  
  370. ============ DEFINE VIEW REQUESTER =================
  371.  
  372. Name
  373.   Identifies the view. This can be changed for a new view, but is display
  374.   only for an existing view.
  375.  
  376. Available Fields List
  377.   Lists the fields in the current file. Clicking on a field will add it to
  378.   the current view.
  379.  
  380. View Fields List
  381.   Lists the fields in the current view. Clicking on a field in this list
  382.   will select it and display its title and length below the list box.
  383.   These can then be changed if required. The changes will only affect the
  384.   current view.
  385.  
  386.   New fields will be added before the current selected field. To add
  387.   fields to the end of the list, select the "== End ==" item.
  388.  
  389. Type Buttons
  390.   Choose type of view - FORM or LIST.
  391.  
  392. Headings Check Box
  393.   Field names are displayed if this is checked. This is normally only
  394.   turned off for printing labels.
  395.  
  396. Field Title String Gadget
  397.   This is the text gadget under the View Fields list. You can change the
  398.   field title for this view only. For example you may want a short title
  399.   for a short field on the list display but use the full name for the form
  400.   display. The title can be blank. This gadget is disabled unless one of
  401.   the View Fields is selected.
  402.  
  403. Length String Gadget
  404.   Use this to reduce or increase the field display length for this view
  405.   only.
  406.  
  407. IMPORTANT NOTE: You must press enter after changing either the field name
  408.   or length or your changes will be ignored.
  409.  
  410. Clear Button
  411.   Deletes all fields from the View Fields list.
  412.  
  413. Delete Button
  414.   Deletes the selected field from the View Fields list.
  415.  
  416. =================== SORT REQUESTER ==================
  417.  
  418. Sort creates a temporary index which is discarded when the file
  419. is closed. The sort sequence will be maintained as you add or delete
  420. records.
  421.  
  422. The sort technique used requires that all sort keys be resident in memory,
  423. so record buffers are freed to increase the memory available to the sort.
  424. If you are short of memory, it may help to sort using less than the full
  425. length of long fields.
  426.  
  427. Available Fields
  428.   Lists the fields defined in this file. Clicking on a field will add it
  429.   to the Sort Fields.
  430.  
  431. Index Fields
  432.   Lists the fields to be used for the sort. The order of the fields
  433.   in this box determines their priority in the sort. The first field is
  434.   the primary key, the second will only be used for records where the
  435.   first keys are equal and so on.
  436.  
  437.   Clicking on a field in this list will select it and display its name
  438.   and length below the list box.
  439.  
  440.   New fields are inserted before the currently selected field. To add a
  441.   field to the end of the list, select the "== End ==" entry.
  442.  
  443. Length
  444.   Changing this length allows you to sort over part of a long field, to
  445.   save memory and speed sorting
  446.  
  447.   IMPORTANT: YOU MUST PRESS ENTER OR RETURN AFTER CHANGING A LENGTH OR
  448.          YOUR CHANGES WILL BE IGNORED
  449.  
  450. Order
  451.   Select A..Z for ascending sequence or Z..A for descending. You can mix
  452.   these on different fields in the same index.
  453.  
  454. Clear Button
  455.   Deletes all fields from the Index Field List
  456.  
  457. Delete
  458.   Deletes the selected field from the Index Fields list.
  459.  
  460. ==================== SELECTION ====================
  461.  
  462. A selection is a sub-set of the data base that matches specified
  463. conditions. QuickFile searches through the whole data base looking for
  464. records with fields matching requested values, and creates an index
  465. containing these records. You can then browse, print, export or create a
  466. new database with the selected records.
  467.  
  468. The selection is updated automatically for deletions and changes but not
  469. additions.
  470.  
  471. When displaying a selection, the title bar will show the number of records
  472. in the selection.
  473.  
  474. The selected data will be in the same sequence as the current Index.  You
  475. can sort it into another sequence if required.    If the current index is
  476. the result of a previous selection, only the selected records are
  477. searched.
  478.  
  479. You can use any number of criteria for a search, but the more you have the
  480. slower the search will be.
  481.  
  482. ============== Search Panel =================
  483.  
  484. The Search Panel displays a list of search criteria with buttons for
  485. inserting, modifying and deleting them.
  486.  
  487. Two values can be specified for each item. The second value is primarily
  488. for the Between operator, but it can be used to specify an alternative
  489. value for the other operators.
  490.  
  491. Clicking on the Insert or Modify displays the Search Details requeste for
  492. you to insert or modify the details.
  493.  
  494. For insertions, the new item will be inserted before the selected item. To
  495. insert a new item at the end of the list, select the "== End ==" item.
  496.  
  497. Clicking on delete will bring up a requester for you to confirm the
  498. deletion of the selected item.
  499.  
  500. Search criteria linked with 'and' will select only records that match both
  501. criteria, while search criteria linked with 'or' will select records that
  502. match either criteria.
  503.  
  504. 'And' has higher precedence so criteria are formed into groups split by
  505. 'or'. All criteria in a group must be satisfied for a record to be
  506. selected, but a record will be selected if it matches any group. That is
  507. confusing and is probably best explained with an example:
  508.  
  509.       Occupation equal     programmer
  510.   and location     equal     sydney
  511.   or  Occupation equal     programmer
  512.   and location     equal     canberra
  513.  
  514. This will find all programmers who live in Sydney or Canberra. Note that
  515. Occupation had to be repeated. The following would give all programmers
  516. who live in Sydney and EVERBODY who lives in Canberra.
  517.  
  518.       Occupation equal     programmer
  519.   and location     equal     sydney
  520.   or  location     equal     canberra
  521.  
  522. You can also do things like
  523.  
  524.        Name     like     john
  525.   and  Name     notlike smith
  526.  
  527. which would find all persons named John, except those named John Smith.
  528.  
  529. ========= Search Details ======================
  530.  
  531. And, Or Buttons
  532.   Choose AND or OR to specify how this search item is combined with the
  533.   previous one. It has no effect for the first item.
  534.  
  535. Available Fields List
  536.   Lists all the fields in the file defintion. The current selection is
  537.   displayed under the list.
  538.  
  539. Comparison Operator (like, equal etc)
  540.   Choose the operator to be used for this search item. (see below)
  541.  
  542. Value 1
  543.   The primary search value. It is always used. If you want to search for
  544.   empty fields leave this empty.
  545.  
  546. Value 2
  547.   This is the secondary search value. Its primary use is with the between
  548.   operator but can be used to enter an second search value for the other
  549.   operators.
  550.  
  551.   Note that with Not Equal and Not Like, value 1 and value 2 are joined by
  552.   AND rather than OR. It will find all records except those that contain
  553.   value 1 or value 2. Using OR in this situation would select every
  554.   record.
  555.  
  556. ======= Search Operators ===============
  557.  
  558. Like
  559.   Matches fields that contain the search string anywhere within them. eg
  560.   "bit" would find "The Hobbit" and "Bitter Sweet".
  561.  
  562. Equal
  563.   Matches a field only if it exactly equals the search value. Case is not
  564.   significant so that dog will match Dog or even dOG.
  565.  
  566. Between
  567.   Matches a field with a value equal to or between the specified pair of
  568.   values. This can also be used to perform a less than or greater than
  569.   search. e.g. 'between 41 and 999' is the same as 'greater than  40'.
  570.  
  571. Sounds Like
  572.   Matches fields where the first word sounds like the search value. This
  573.   is really a bit of a gimmick as it is not very smart. NOTE it only looks
  574.   at the first word of the field.
  575.  
  576. Not Like
  577.   As for like but only matches records that do not contain the search
  578.   value.
  579.  
  580. Not Equal
  581.   As for equal but only matches records that do not match the search
  582.   value.
  583.  
  584. ====== EXPORT REQUESTER ======
  585.  
  586. A number of preset formats are provided or you can tailor your own record
  587. and field Separators by selecting the Custom format.
  588.  
  589. The headers button determines whether a header record containing the field
  590. names is to be included at the start of the file.
  591.  
  592. Pressing the OK Button displays a file requester for you to specify the
  593. name of the export file.
  594.  
  595. All records from the current index will be written. If you are displaying
  596. Selected records, only the selected records will be written.
  597.  
  598. ====== IMPORT REQUESTER ======
  599.  
  600. One preset format("...",) is provided or you can tailor your own by
  601. selecting Custom and choosing the Record and Field separators.
  602.  
  603. Both sequence and length can be different from that in the database. Also,
  604. not all database fields need to be present in the ASCII file. Any fields
  605. not present will be set to blank in your data base.
  606.  
  607. NB: It is vital that the sequence and number of fields you set in the
  608. selected fields box of the field selector correspond to the sequence of
  609. fields in the ASCII file you are importing.
  610.  
  611. Make you sure to backup your database before you import a file into an
  612. existing data base. If you get the format wrong, it is easier to restore
  613. than to fix or delete all of the incorrect records.
  614.  
  615. Also use plenty of buffers if you are going to import a large number of
  616. records.
  617.  
  618. ============ Preset Export/Import Formats =================
  619.  
  620. A number of preset formats are provided including the mailmerge formats for
  621. some wordprocessors:
  622.  
  623.  Custom
  624.    Allows you to define your own format using predefined Separator
  625.    characters.
  626.  
  627.  "...",
  628.    This is a quote and comma delimited text file such as used for data for
  629.    BASIC programs.
  630.  
  631. The following preset formats are available only for Export, not Import.
  632.  
  633.     Final Copy
  634.     Interword
  635.     KindWords 3
  636.     ProWrite
  637.     WordWorth
  638.  
  639. Only the KindWords 3 and Interword versions have been tested.
  640.  
  641. ====== Field and Record Separators ========
  642.  
  643. You can only select from the predefined delimiter codes.
  644.  
  645.   Field Start
  646.   The character that marks the start of a field.
  647.  
  648.   Field End
  649.   Marks the end of a field. It differs from the field separator in that a
  650.   separator does not appear after the last field in a record while a field
  651.   end character appears after every field.
  652.  
  653.   Field Separator
  654.   Separates fields in the record. It does not appear after the last field
  655.   in the record
  656.  
  657.   Record End
  658.   Marks the end of a record
  659.  
  660. If Field Start is used, a Field End must also be used. If neither Field End
  661. nor Field Separator is used, the records will be fixed length with each
  662. field padded to its maximum length with spaces.
  663.  
  664.  
  665. ============= PRINT REQUESTER =====================
  666.  
  667. Title
  668.   This is printed, centered, at the top of each page of your report.
  669.   Current date is printed at the left margin and the page number at the
  670.   right margin.
  671.  
  672.   The title line is only printed if you enter a Title. Note that even a
  673.   single space will print a blank title.
  674.  
  675. Left and Right Margins
  676.   Character position of left and right margin.
  677.  
  678. Lines/Page
  679.   This controls the number of lines QuickFile will use on each page. The
  680.   default is paper size minus 8 to provide a top and bottom margin.
  681.  
  682.   NB QuickFile issues a Form Feed when a new page is required. This
  683.   relies on your setting the page height on your printer correctly, and
  684.   may be a limitation with some printers. If you have a problem with this,
  685.   let me know and I will look at using the preferences paper size.
  686.  
  687.   A value of zero will suppress the report title and page breaks.
  688.  
  689. Print Pitch Cycle Gadget.
  690.   As for Workbench printer preferences
  691.  
  692. Lines Per Inch Cycle Gadget
  693.   This button toggles between 6 and 8 lines per inch.
  694.  
  695. Output To Cycle Gadget
  696.   Allows you to send the report to the printer or the window.
  697.  
  698. If you are printing a FORM view, a number of additional fields are
  699. displayed for multi-column printing such as address labels. See Labels for
  700. full details.
  701.  
  702. If you are printing a LIST view, a Group By list is displayed. This lists
  703. the report groups defined for this report. See Report Groups.
  704.  
  705. Press the OK button to start printing or the cancel button to cancel any
  706. changes you have entered.
  707.  
  708. Saving the view will save all of your report settings.
  709.  
  710. ========= Labels ============
  711.  
  712. Label printing is available for FORM type views only. You will normally
  713. define a special view and:
  714.  
  715.    Set Field Labels for the view to No
  716.  
  717.    Arrange the fields in the top left hand corner of the FORM screen to
  718.    match the desired label format
  719.  
  720.    Use the following fields in the print requester to control your label
  721.    format.
  722.  
  723. Labels Across
  724.   Number of labels to print across the page
  725.  
  726. Label Width
  727.   Width of each label. One additional space will be allowed
  728.   between labels. If you want to print labels further apart, increase this
  729.   value.
  730.  
  731. Labels Down
  732.   Number of labels to print down the page before starting a new column.
  733.   For example 3 across and 4 down will print in the following sequence:
  734.  
  735.       1      5      9
  736.       2      6     10
  737.       3      7     11
  738.       4      8     12
  739.  
  740. Label Height
  741.   Height of each label in lines. An additional blank line will be printed
  742.   between each label. The default is the number of lines in the form.
  743.  
  744. You will probably want to set Lines Per Page to zero to suppress page
  745. breaks as well.
  746.  
  747. If you are printing a single column of labels only, you can leave all of
  748. the above fields blank and let the number of lines in the form determine
  749. the label height.
  750.  
  751. ======== Report Groups ===================
  752.  
  753. You may know report groups as control breaks. A "group by" field is only
  754. printed when its value changes. You can also calculate summary values for
  755. each group. Each group can be based on several fields, although usually
  756. only one is used. Any number of fields may be summarised for a group.
  757.  
  758. Note that records must be sorted into the correct sequence for this to
  759. work correctly. They are not sorted automatically.
  760.  
  761. The types of groups available are
  762.  
  763. Report.  Gives a summary value for the whole report. If used, it must
  764.      be the first group in the list.
  765. Page.     Groups will start on a new page. Group fields will print
  766.      before column headings.
  767. Subtitle Prints the group fields on a separate line at the start of each
  768.      group. Reduces line length but best when each group contains
  769.      a good number of records.
  770. Normal     Field prints in the first line of the group only, but space
  771.      is used in each line.
  772.  
  773. You can have several levels of groups of the same type, but they must be
  774. listed from highest level to lowest.
  775.  
  776. ============= Report Group Example ============
  777.  
  778. The following example shows two groups with totals.
  779.  
  780.    Group 1 : City     Type: Normal   Group Fields: City
  781.                      Summaries:    Value (total)
  782.  
  783.    Group 2 : Salesman Type: Normal   Group Fields: Salesman
  784.                      Summaries:    Value (total)
  785.  
  786.    Resulting report:
  787.  
  788.     City    Salesman    Client             Value
  789.     ----------    -------------    --------------     ---------
  790.     Brisbane    Fred Smith    ABC Company       8000.00
  791.                 XYZ Limited       6400.00
  792.                 Zip Electronics   12000.00
  793.  
  794.     Salesman Tot                  26400.00
  795.  
  796.         John Brown    ZZZ Computers       5000.00
  797.                 GWZ Peripherals    7200.00
  798.  
  799.     Salesman Tot                  12200.00
  800.  
  801.     City Tot                      28600.00
  802.  
  803. Note: The file must be sorted over City and Salesman for this to print
  804. correctly.
  805.  
  806. ========== Report Group Requester ============
  807.  
  808. This defines the type, grouping fields, and summaries for a single report
  809. group.
  810.  
  811. Group string gadget
  812.   Names the group. This name is printed on summary lines.
  813.  
  814. Type
  815.   Type of group
  816.  
  817. View Fields list
  818.   Lists the fields available in the current view. The selected field in
  819.   this list can be added to either the Group Fields or Summaries lists.
  820.  
  821. Group Fields list
  822.   Lists the fields used for gouping. A new group starts when any of these
  823.   fields change. A group field is not required for a Report level group.
  824.  
  825. Summaries list
  826.   Lists the fields to be summarised for this group. Selecting an item from
  827.   this list will update the check boxes to show the summaries requested.
  828.   Use the INS button to add the selected view field to this list.
  829.  
  830. Tot, Cnt, Avg check boxes
  831.   Show the summaries required for the currently selected Summary field.
  832.   Any or all may be checked for one field.
  833.  
  834. OK and Cancel Buttons
  835.   Return to the Print Requester.
  836.  
  837. ============== DEFINING FILES  ===================
  838.  
  839. Use the Project/New menu item to define a new file.
  840.  
  841. Use the Project/Alter menu item to change the definition for the current
  842. file.
  843.  
  844. You can change just about everything in a file definition, except the
  845. block size, even after you have loaded data to the file. You can change
  846. field names, types and lengths. You can add or delete fields, and add or
  847. delete indexes. Caution should be used when changing the type for fields
  848. that contain data.
  849.  
  850. WARNING: Deleting a field makes its data inaccessible, even if you
  851.        re-add the same field. If you accidentally delete a field, reload
  852.        the definition without saving your changes and start your changes
  853.        again.
  854.  
  855. The fields defined for this file are listed in the box at the right of the
  856. window. Use the buttons beside the window to add, change or delete fields.
  857.  
  858. If a field is highlighted when you press add, the new field will be added
  859. before the selected field. To add a field to the end of the list, select
  860. the "== End ==" item.
  861.  
  862. The indexes (indices?) are listed in the box at the lower left. Use the
  863. buttons to add, change or delete indexes.
  864.  
  865. ================ File Details =================
  866.  
  867. The file details are shown at the top left of the QFDefine window
  868.  
  869. Block Size
  870.   QuickFile does not read and write single records at a time, but builds
  871.   them into blocks. This reduces the number of disk reads and writes
  872.   required. Around 2000 seems to give good results. The only way to change
  873.   block size is to export the whole file, define a new data base and use
  874.   import to recreate your file. Block size must be larger than the maximum
  875.   record size plus free space, plus some space for control fields (2 bytes
  876.   per field plus 2 bytes for the record length).
  877.  
  878. Free Space
  879.   The amount of free space to be left in each block to allow for records
  880.   to expand. As QuickFile only stores the actual data entered (not
  881.   trailing blanks), additional space is required if a change makes a field
  882.   longer. 100 seems to work OK. Records are moved to another block if
  883.   necessary, so this is not critical.
  884.  
  885. Buffers
  886.   Maximum number of buffers QuickFile will use for holding blocks of
  887.   records in memory. Unless you have very large files or are short of
  888.   memory, use a large figure such as 100.  QuickFile will never use more
  889.   buffers than are required for the whole file.
  890.  
  891.   The more of the file in memory, the faster QuickFile works. The memory
  892.   used is approximately (number of buffers * buffer size).
  893.  
  894.   WARNING. If you using a compression program like XFH-handler with
  895.   QuickFile, set the number of buffers to 3. XFH will already have the
  896.   decompressed copy of the file in ram.
  897.  
  898. =========== Field Requester ===========
  899.  
  900. Name string gadget
  901.   Enter a name of up to 12 characters for the field.
  902.  
  903. Length
  904.   60 characters is a practical maximum length as no left and right
  905.   scrolling is provided and more characters cannot be displayed.
  906.   The maximum is 250. The minimum length of a date field is 11 characters.
  907.  
  908.   Space is used only for the number of characters entered in each record,
  909.   not for the maximum field length. In fact, if a field is empty it takes
  910.   up no space at all.
  911.  
  912. Decimals
  913.   Number of decimals stored and displayed for the field. Values entered in
  914.   the field will be rounded to this number of decimals.
  915.  
  916. Type Cycle Gadget
  917.   Choose type of field.
  918.  
  919. Mandatory Check Box
  920.   If checked, the field must have a value in all records. You will not be
  921.   able to add a new record without a value in this field.
  922.  
  923. Justify Right Check Box
  924.   If checked, the field is right justified. Integer, Float, and Caculated
  925.   fields default to right, character and date fields default to left.
  926.  
  927. Expression String Gadget
  928.   How to calculate the field value. The expression can contain field
  929.   names, constants, and the add (+), subtract (-), multiply (*) and divide
  930.   (/) operators. Field names that contain spaces must be enclosed in
  931.   double quotes ("). Normal precedence rules apply and brackets may be
  932.   used to control sequence. Fields must be defined before they can be
  933.   referenced.
  934.  
  935. =============== Field Types ===============
  936.  
  937. Character
  938.   This the usual character string.
  939.  
  940. Date
  941.   These have a minimum length of 11 characters and are always entered as
  942.   day/month/year.
  943.  
  944.   The separator can be any of /-. or a space.
  945.  
  946.   Month can be entered as a number or a three character name
  947.  
  948.   Year can be entered as two or four digits. If two digits are used, a
  949.   number greater than 50 is assumed to be this century, 50 or less, the
  950.   next century.
  951.  
  952.      eg. 3/6/94   is interpreted as 03-Jun-1994
  953.      1-aug-10 is interpreted as 01-Aug-2010
  954.  
  955.   Leading zeroes can be omitted.
  956.  
  957.   Dates are always displayed in the format 14-Apr-1993.
  958.  
  959.   The following are valid dates
  960.        03/08/93  3-8-93  3.aug.93  03 aug 1993
  961.  
  962. Integer
  963.   Whole number, no decimals.
  964.  
  965. Float.
  966.   Real numbers with decimals.
  967.  
  968. Calculated
  969.   The field value is calculated from other fields, which may themselves be
  970.   calculated fields.
  971.  
  972. ============== Indexes =============
  973.  
  974. You must define at least one index. If you are not sure pick any field
  975. that will give a useful sequence, such as surname, title etc. Each index
  976. can use a number of fields to give precise control of sequence.
  977.  
  978. You can have any number of indexes but you should limit yourself to those
  979. you are going to use regularly.
  980.  
  981. You can index on any field type including calculated fields. You can also
  982. define an index as unique to prevent duplicate records being created.
  983.  
  984. If you change an index on an existing file, it will be rebuilt when you
  985. return to the main display panel.
  986.  
  987. Select the index from the list and press the appropriate button. The Index
  988. Requester is used to define or alter an index definition.
  989.  
  990. Indexes are maintained automatically as you add, modify and delete records
  991. on your file so they reduce the need for sorting and resorting.
  992.  
  993. ============ Define Index Requester =================
  994.  
  995. Name
  996.   Identifies the index and is also used to form the index file name.
  997.  
  998. Unique CheckBox
  999.   If checked, duplicate index entries will not be allowed.
  1000.  
  1001. Available Fields
  1002.   Lists fields defined in this file. Clicking on a field will add it to
  1003.   the fields selected for this index.
  1004.  
  1005. Index Fields
  1006.   Lists fields in the current index. The order of the fields in this box
  1007.   determines their priority in the sort. The first field is the primary
  1008.   key, the second will only be used for records where the first keys are
  1009.   equal and so on.
  1010.  
  1011.   Clicking on a field in this list will select it and display its name
  1012.   and length below the list box.
  1013.  
  1014.   If a field is highlighted, any new fields will be added before the
  1015.   highlighted field, otherwise new fields will be added at the end. To
  1016.   remove highlighting click in the blank part of the box.
  1017.  
  1018. Length
  1019.   Changing this length allows you to index on part of a long field. This
  1020.   reduces memory usage and may increase speed.
  1021.  
  1022.   IMPORTANT: YOU MUST PRESS ENTER OR RETURN AFTER CHANGING A LENGTH OR
  1023.          YOUR CHANGES WILL BE IGNORED
  1024.  
  1025. Order Buttons
  1026.   Select A..Z for ascending order or Z..A for descending order. You can
  1027.   mix these on different fields in the same index.
  1028.  
  1029. Delete
  1030.   Deletes the highlighted field from the Index Fields list.
  1031.  
  1032. ===== FILE NAMES =============
  1033.  
  1034.    QuickFile uses four types of file distinguished by extension. Changing
  1035.    these with an  editor will probably corrupt the file. YOU HAVE BEEN
  1036.    WARNED.
  1037.  
  1038.    The DEFINITION FILE has no extension. This is the name you enter when
  1039.    specifying a file name for QuickFile.
  1040.  
  1041.    The DATA FILE has an extension of .Data.
  1042.  
  1043.    VIEW files usually have an extension of .View
  1044.  
  1045.    INDEX FILES have an extension of .nameX where 'name' is the name of the
  1046.    index as specified in the file definition.
  1047.  
  1048. ========== POSSIBLE PROBLEMS =================
  1049.  
  1050. INDEX DOESN'T MATCH DATA FILE
  1051.  
  1052. It is possible for an index and data file to get out of synchronisation.
  1053. This can be caused by not closing a file properly, typically because of a
  1054. guru or power loss with a file open.
  1055.  
  1056. If you suspect an index has been corrupted in some way, you can delete the
  1057. index file (called filename.indnameX).  When you next open the file, the
  1058. index will be rebuilt.    This is indicated by a message such as "getblock:
  1059. Block not found" being displayed in the Console window.
  1060.  
  1061. You can also rebuild an index by selecting the Rebuild Index item from
  1062. the QuickFile tools menu.
  1063.  
  1064. SAVING MEMORY
  1065.  
  1066. If you are short of memory, you can reduce memory requirements by not
  1067. using the online help. You can do this by either removing
  1068. AmigaGuide.library from your libs: directory or by moving QuickFile.guide
  1069. to a different directory from the QuickFile program.
  1070.  
  1071. If you are using a compression program such as XFH-handler, reduce the
  1072. number of buffers in the file definition to 3. Otherwise both XFH and
  1073. QuickFile will be holding the file in ram:
  1074.  
  1075. ========== Program Limits ==============
  1076.  
  1077. Field Length
  1078.  
  1079.     While up to 250 characters are allowed per field, this is not very
  1080.     useful as each field is limited to one line.
  1081.  
  1082. Number of Records per File
  1083.  
  1084.     The theoretical limit is currently 65,535. In practice it is much
  1085.     lower because of the indexing technique which will run out of either
  1086.     memory or processor speed. Each index requires a contiguous area of
  1087.     RAM 4(n + 200) bytes in size, where n is the number of records in the
  1088.     file. The sort technique also limits the size of the file.    The sort
  1089.     loads all sort keys to ram and also requires 8 bytes per record in one
  1090.     contiguous area.
  1091.  
  1092.     A realistic maximum is probably in the order of 10,000 to 20,000.
  1093.  
  1094. Number of fields per record
  1095.  
  1096.   250. But I got bored at about 60, so you take your chances if you want
  1097.   to try more.
  1098.  
  1099. Number of indexes
  1100.  
  1101.   No limit.
  1102.  
  1103.